fix: clientMethodTrace missing original properties #2650

bgpo · 2021-12-06T05:48:07Z

Which problem is this PR solving?

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #2580 by assigning the properties from original back to clientMethodTrace.

opentelemetry-js/experimental/packages/opentelemetry-instrumentation-grpc/src/grpc-js/index.ts

Lines 268 to 294 in 4e311bd

    
             /** 
        
              * Parse initial client call properties and start a span to trace its execution 
        
              */ 
        
             private _getPatchedClientMethods( 
        
               grpcClient: typeof grpcJs 
        
             ): (original: GrpcClientFunc) => () => EventEmitter { 
        
               const instrumentation = this; 
        
               return (original: GrpcClientFunc) => { 
        
                 instrumentation._diag.debug('patch all client methods'); 
        
                 return function clientMethodTrace(this: grpcJs.Client) { 
        
                   const name = `grpc.${original.path.replace('/', '')}`; 
        
                   const args = [...arguments]; 
        
                   const metadata = getMetadata.call( 
        
                     instrumentation, 
        
                     grpcClient, 
        
                     original, 
        
                     args 
        
                   ); 
        
                   const span = instrumentation.tracer.startSpan(name, { 
        
                     kind: SpanKind.CLIENT, 
        
                   }); 
        
                   return context.with(trace.setSpan(context.active(), span), () => 
        
                     makeGrpcClientRemoteCall(original, args, metadata, this)(span) 
        
                   ); 
        
                 }; 
        
               }; 
        
             }

The original is a function and an object. For more details see below:

https://github.com/grpc/grpc-node/blob/1ddd8ae4e7e507f75b1bb56e3f91bd9261004d31/packages/grpc-js/src/make-client.ts#L133-L171

The returned function clientMethodTrace is without those extra object entries.

Short description of the changes

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Test assigning properties from original client method to patched client method

Checklist:

Followed the style guidelines of this project
Unit tests have been added
Documentation has been updated

linux-foundation-easycla · 2021-12-06T05:48:09Z

The committers are authorized under a signed CLA.

✅ bgpo (9c09376)

codecov · 2021-12-06T15:08:15Z

Codecov Report

Merging #2650 (f87e6b2) into main (09d3f68) will increase coverage by 0.00%.
The diff coverage is n/a.

❗ Current head f87e6b2 differs from pull request most recent head 20d5396. Consider uploading reports for the commit 20d5396 to get more accurate results

@@           Coverage Diff           @@
##             main    #2650   +/-   ##
=======================================
  Coverage   93.09%   93.10%           
=======================================
  Files         123      123           
  Lines        4753     4757    +4     
  Branches     1059     1059           
=======================================
+ Hits         4425     4429    +4     
  Misses        328      328

Impacted Files	Coverage Δ
...entelemetry-instrumentation-grpc/src/grpc/index.ts	`93.10% <0.00%> (+0.12%)`	⬆️
...elemetry-instrumentation-grpc/src/grpc-js/index.ts	`90.90% <0.00%> (+0.18%)`	⬆️

dyladan · 2021-12-06T15:48:55Z

Can you please copy the explanation from the issue onto this and provide a test?

Thanks for debugging this

bgpo requested a review from a team December 6, 2021 05:48

dyladan added the bug Something isn't working label Dec 6, 2021

bgpo force-pushed the main branch from 9c09376 to e48b26e Compare December 7, 2021 07:13

fix: clientMethodTrace missing original properties

4b90c33

bgpo force-pushed the main branch from e48b26e to 4b90c33 Compare December 7, 2021 07:16

Merge branch 'main' into main

20d5396

dyladan approved these changes Dec 8, 2021

View reviewed changes

vmarchaud approved these changes Dec 8, 2021

View reviewed changes

dyladan merged commit f51f853 into open-telemetry:main Dec 8, 2021

MSNev approved these changes Dec 8, 2021

View reviewed changes

dyladan mentioned this pull request Mar 16, 2022

chore: release proposal 1.1.0 #2838

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: clientMethodTrace missing original properties #2650

fix: clientMethodTrace missing original properties #2650

bgpo commented Dec 6, 2021 •

edited

Loading

linux-foundation-easycla bot commented Dec 6, 2021 •

edited

Loading

codecov bot commented Dec 6, 2021 •

edited

Loading

dyladan commented Dec 6, 2021

	/**
	* Parse initial client call properties and start a span to trace its execution
	*/
	private _getPatchedClientMethods(
	grpcClient: typeof grpcJs
	): (original: GrpcClientFunc) => () => EventEmitter {
	const instrumentation = this;
	return (original: GrpcClientFunc) => {
	instrumentation._diag.debug('patch all client methods');
	return function clientMethodTrace(this: grpcJs.Client) {
	const name = `grpc.${original.path.replace('/', '')}`;
	const args = [...arguments];
	const metadata = getMetadata.call(
	instrumentation,
	grpcClient,
	original,
	args
	);
	const span = instrumentation.tracer.startSpan(name, {
	kind: SpanKind.CLIENT,
	});
	return context.with(trace.setSpan(context.active(), span), () =>
	makeGrpcClientRemoteCall(original, args, metadata, this)(span)
	);
	};
	};
	}

fix: clientMethodTrace missing original properties #2650

fix: clientMethodTrace missing original properties #2650

Conversation

bgpo commented Dec 6, 2021 • edited Loading

Which problem is this PR solving?

Short description of the changes

Type of change

How Has This Been Tested?

Checklist:

linux-foundation-easycla bot commented Dec 6, 2021 • edited Loading

codecov bot commented Dec 6, 2021 • edited Loading

Codecov Report

dyladan commented Dec 6, 2021

bgpo commented Dec 6, 2021 •

edited

Loading

linux-foundation-easycla bot commented Dec 6, 2021 •

edited

Loading

codecov bot commented Dec 6, 2021 •

edited

Loading